home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / diskutil / menusystems / cliva / cliva.doc < prev    next >
Text File  |  1996-09-07  |  11KB  |  287 lines
  1. @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@##########################
  2. @@@@@@     @@   @@@@@     @@   @@@   @@@@   @@@@@@@####     #######     #####
  3. @@@@@   @@@@@   @@@@@@   @@@   @@@   @@@     @@@@@@###  ###  #####  ###  ####
  4. @@@@@   @@@@@   @@@@@@   @@@   @@@   @@   @   @@@@@########  #####  ###  ####
  5. @@@@@   @@@@@   @@@@@@   @@@@   @   @@@       @@@@@####     ######  ###  ####
  6. @@@@@   @@@@@   @@@@@@   @@@@   @   @@   @@@   @@@@###  ##########  ###  ####
  7. @@@@@@     @@      @@     @@@@    @@@@   @@@   @@@@###      ##  ###     #####
  8. @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@##########################
  9.  
  10. CliVa v2.0 Copyright © 1991 1992 1993 Christian Warren  All rights reserved.
  11. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  12.    CliVa is placed in the Public Domain for the Amiga.  A shareware fee
  13. of 15$ is suggested to use it.  Feel free to use it, but AT YOUR OWN RISK,
  14. as I cannot be considered responsible for any damage caused to your system.
  15. Introduction
  16. ~~~~~~~~~~~~
  17.    CliVa will give you the chance to build a interface entirely configurable
  18. to launch your applications from gadgets.
  19.    To use CliVa, you must have the 'PowerPacker.library' (permit the
  20. compression of the config) and the 'req.library'.
  21.  
  22. Requirement
  23. ~~~~~~~~~~~
  24.    - CliVa must be able to access the 'PowerPacker.library', the
  25.    'req.library' and the 'diskfont.library'.
  26.    - The file 'echo', 'execute', 'newshell' and 'mouse' must be present in one
  27.    of the directory of the path.
  28.    - The OS 2.0 IS NOT required for CliVa.
  29.  
  30. Information on the CliVa executable
  31. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32.    - CliVa is 'pure', you can make it resident.
  33.  
  34.    SHELL usage:
  35.             Cliva {-configuration} Other.config {-configuration}
  36.  
  37.    WORKBENCH usage:
  38.             -configuration
  39.             ...
  40.             Other.config
  41.             ...
  42.  
  43.    argument:
  44.       '-configuration' ==> CliVa take the arguement as if it as been placed at
  45.                            the beginning of the config file.
  46.                         ex.
  47.                            CliVa "-TASK_PRIORITE 3" "-SET_VAR BLACK 0"
  48.  
  49.       'Other.config' ==> Config to load.  By default, CliVa search in the
  50.                          current path for the file 'CliVa.config' then he
  51.                          search it in the directory S:.
  52.                       ex.
  53.                          CliVa Other.config
  54.  
  55.  
  56. CliVa Configuration Commands
  57. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  58.      Name:  TASK_PRIORITY
  59.    format:  -TASK_PRIORITY priority
  60.   default:  priority = 0
  61.  function:  Define the task priority of CliVa, must be between -19 and +19.
  62.  
  63.      Name:  DEF_WINDOW_EXECUTE
  64.    format:  -DEF_WINDOW_EXECUTE shell_window_definition
  65.   default:  "CON:000/095/640/105/CliVa_Shell"
  66.  function:  Define all shell output specifications which will be opened if
  67.             the selected gadget needs an output window.
  68.  
  69.      Name:  ON_SCREEN
  70.    format:  -ON_SCREEN my_screen
  71.   default:  "Workbench"
  72.  function:  Opens CliVa on a particular screen. The supplied name of the
  73.             screen can consist of the first few letters of the targeted
  74.             real name screen. If the screen is not found, CliVa will open
  75.             on the default screen. Make sure you close CliVa before you
  76.             close the screen it is on, because you will be meditating about
  77.             your error while rebooting your system.:-)
  78.             ex. -ON_SCREEN CED  -> Open Cliva on the Cygnus Ed screen
  79.  
  80.      Name:  ICONIFIED
  81.    format:  -ICONIFIED
  82.  function:  CliVa will start iconified.
  83.  
  84.      Name:  ICON_WHEN_EXECUTE
  85.    format:  -ICON_WHEN_EXECUTE
  86.  function:  The 'AutoIconify' option in the menu will be selected.
  87.             (more on this AutoIconify function further down)
  88.  
  89.      Name:  WINDOW_TITLE
  90.    format:  -WINDOW_TITLE title
  91.   default:  "CliVa 2.0 (c) 1991-1993 Christian Warren"
  92.  function:  Changes the window title. If CliVa's configuration is more
  93.             than one page, the following will be inserted "   (Page xxx/max )"
  94.             to the titlebar. If the NO_DRAG_BAR option is used, the Screen
  95.             titlebar will be used.
  96.  
  97.      Name:  NO_DRAG_BAR
  98.    format:  -NO_DRAG_BAR
  99.  function:  The window does not have a visible DragBar. CliVa will create
  100.             invisible gadgets to replace those that are eliminated.
  101.             Those invisible gadgets will be placed at the top of the window.
  102.  
  103.      Name:  NO_MENU
  104.    format:  -NO_MENU
  105.  function:  Does not attach a menu to the screen. You must define a "Quit"
  106.             gadget if you want to be able to Quit CliVa.
  107.  
  108.      Name:  FONT
  109.    format:  -FONT font height
  110.   default:  system font by default.
  111.  function:  Define the font to be used and its height.
  112.             ex. -FONT Diamond.font 14
  113.  
  114.      Name:  POS_WINDOW
  115.    format:  -POS_WINDOW position_x position_y
  116.   default:  position_x = 0             position_y = 11
  117.  function:  Define CliVa's top left window corner. If your entry is more
  118.             then the screen border, the position will be ajusted to be as
  119.             close as possible. An example would be if you define X as 2000,
  120.             then CliVa's window will be against the right side screen border.
  121.  
  122.      Name:  COLOR_WINDOW
  123.    format:  -COLOR_WINDOW Letter_color Background_color
  124.   default:  Letter_color = 2         Background_letter_color = 1
  125.  function:  Define colors to be used in the window. These colors are, among
  126.             things, used for menus and window border.
  127.  
  128.      Name:  COLOR_BACKGROUND
  129.    format:  -COLOR_BACKGROUND color
  130.   default:  color = 2
  131.  function:  Define color for background of the window.
  132.  
  133.      Name:  NB_GADGETS
  134.    format:  -NB_GADGETS nb_horizontal nb_vertical
  135.   default:  nb_horizontal = 5          nb_vertical = 4
  136.  function:  Define how many horizontal and vertical gadgets.
  137.  
  138.      Name:  UP_TO_DOWN
  139.    format:  -UP_TO_DOWN
  140.  function:  The gadgets will be numbered from top to buttom instead of
  141.             left to right.
  142.  
  143.             NORMAL               UPDOWN
  144.             1  2  3              1  4  7
  145.             4  5  6              2  5  8
  146.             7  8  9              3  6  9
  147.  
  148.      Name:  SIZE_GADGET
  149.    format:  -SIZE_GADGET Width height
  150.   default:  width = 112              height = 13
  151.  function:  Define width and height of gadgets.
  152.  
  153.      Name:  PIXEL_BETWEEN_GADGET
  154.    format:  -PIXEL_BETWEEN_GADGET space_x space_y
  155.   default:  space_x = 12             space_y = 4
  156.  function:  Define space, in pixels, between the gadgets.
  157.  
  158.      Name:  PIXEL_FROM_BORDER
  159.    format:  -PIXEL_FROM_BORDER left right top buttom
  160.   default:  left = 16    right = 16    top = 5    buttom = 5
  161.  function:  Define space, in pixels, between the gadgets and the border
  162.             of the window.
  163.  
  164.      Name:  COLOR_BORDER_GADGET
  165.    format:  -COLOR_BORDER_GADGET color_Top color_Buttom
  166.   default:  color_Top = 1            color_Buttom = 0
  167.  function:  Define colors to be used for the gadgets borders.
  168.  
  169.      Name:  COLOR_GADGET_DEF
  170.    format:  -COLOR_GADGET_DEF Letter_color Back_color
  171.   default:  Letter_color = 1         Back_color = 2
  172.  function:  Define default color for gadgets.
  173.  
  174.      Name:  FONT_STYLE
  175.    format:  -FONT_STYLE style
  176.   default:  NORMAL
  177.  function:  Define default font style for the gadgets. You must enter
  178.             a number defining the font style.
  179.             PLAIN TEXT = 0             UNDERSCORE = 1
  180.               BOLDFACE = 2                ITALICS = 4
  181.               EXTENDED = 8
  182.             ex. BOLDFACE + ITALICS -> 2 + 4  ==> -FONT_STYLE 6
  183.  
  184.      Name:  GADGET_ICONIFIED
  185.    format:  -GADGET_ICONIFIED name
  186.   default:  "CliVa"
  187.  function:  Define what will be written in CliVa's iconified window.
  188.  
  189.      Name:  DEF_ICON
  190.    format:  -DEF_ICON position_x position_y width
  191.   default:  position_x = 0     position_y = 11     width = 100
  192.  function:  Define CliVa's top left window corner position and width.
  193.              ( minimum width = 26)
  194.             The X and Y arguments are subject to the same defenition of
  195.             POS_WINDOW. The height of the window will respect the
  196.             gadgets height.
  197.  
  198.      Name:  SET_VAR
  199.    format:  -SET_VAR name value
  200.  function:  Define a variable to ease creation of scripts.
  201.             You can define as many variables as you wish. Once defined,
  202.             CliVa will replace the -name- by its -numeric_value- when a
  203.             configuration needs a number as an argument.
  204.             If a variable name is define more than once, only the first
  205.             occurance will be used. Variables usage is encouraged to create
  206.             easy modifiable scripts.
  207.  
  208.             ex.   -SET_VAR red                3
  209.                   -SET_VAR blue               2
  210.                   -SET_VAR Boldface_Undescore 3
  211.  
  212.                   -COLOR_GADGET_DEF red blue
  213.                   -FONT_STYLE Boldface_Undescore
  214.  
  215. Notes.
  216.       - The variables defined by SET_VAR can be used anywhere when the
  217.         argument required is a number.
  218.    ex. -SET_VAR red 2                   <= OK
  219.        -SET_VAR Titre "CliVa 2.0"  <= ERROR
  220.        -COLOR_BACKGROUND red       <= OK
  221.        -WINDOW_TITLE Title         <= ERROR
  222.        -WINDOW_TITLE red           <= window title -> 'red'
  223.  
  224.       - The argument which have imbedded spaces must be quoted using '"'.
  225.          ex. -WINDOW_TITLE "CliVa 2.0"
  226.  
  227.       - These commands MUST BE placed before any gadget definition.
  228.         If a command is placed after a gadget definition, it will be shown
  229.         in the gadget definition.
  230.  
  231.       - You can comment lines using the '#' at the beginning of the line.
  232.  
  233. Gadgets definition
  234. ~~~~~~~~~~~~~~~~~~
  235.  
  236.    These arguments are used to define a gadget.
  237.       Title of gadget = Chain of characters to be written in the gadget. The
  238.                         title of the gadget can contain [<number>]. It will
  239.                         insert the content of the defined variable <number>.
  240.                         If the variable's value changes, it will be reflected
  241.                         in the gadget's title
  242.                         ex.
  243.                            variable 1 = "OS 2.0"
  244.                            title      = "Color [1]"
  245.                            Result    -> "Color OS 2.0"
  246.       Letter_color  = Color used for the letters in a gadget.
  247.       Back_color    = Color for the background in a gadget.
  248.       Font_style    = Font style for a gadget.
  249.                         (see configuration FONT_STYLE)
  250.  
  251.    Nine types of gadgets are possible:
  252.  
  253.    ------------------------ 1. Starting Command  --------------------------
  254.  
  255.       format:
  256.          =S
  257.          Command
  258.          [Command ...]
  259.       function:
  260.          Define the commands that will be executed when Starting CliVa.
  261.          No gadgets will be created. This can be usefull if you want to
  262.          assign some values by default to certain variable.
  263.       example:
  264.          =S
  265.          \vs[1]Workbench
  266.          \vs[2]df0:
  267.          \vs[3]df1:
  268.  
  269.          =D "DiskCopy from [2] to [3]"
  270.          DiskCopy \vu[2] TO \vu[3]
  271.  
  272.    ------------------------------ 2. Gadget -------------------------------
  273.  
  274.       format:
  275.          =D Title [Letter_color] [Back_color] [Font_style]
  276.          Command
  277.          [Command ...]
  278.       function:
  279.          Define a gadget. You must supply a title, others are optional.
  280.       example:
  281.          =D "Avail" red blue
  282.          Avail\w
  283.  
  284.    ------------------------------- 3. Menu --------------------------------
  285.  
  286.       format:
  287.          =D* Title [Lette